docs: dedup lead paragraph, number on-this-page TOC#403
Merged
Conversation
The frontmatter description already renders as the page lead; 16 pages repeated it verbatim (or near-verbatim) as the first body paragraph.
Auto-number top-level entries via a CSS counter and strip any authored N. prefix so it isn't doubled; sub-headings keep their dot marker.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (18)
💤 Files with no reviewable changes (16)
📝 WalkthroughWalkthroughThe documentation updates add automatic numbering to top-level TOC entries, prevent duplicate authored heading numbers, consolidate page descriptions into metadata, and replace selected introductory text with structured components or callouts. ChangesDocumentation navigation and content
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two small docs-site fixes.
Duplicate lead paragraph
The frontmatter
descriptionalready renders as the page lead (below the H1). 16 pages then repeated that same sentence — verbatim or lightly reworded — as their first body paragraph, so it showed twice (e.g. Quickstart's "Build your first task queue in 5 minutes."). Removed the redundant body paragraph on those pages. Left intro paragraphs that genuinely elaborate (e.g. prefork, node events) untouched.Numbered on-this-page TOC
Top-level "On this page" entries are now auto-numbered (1., 2., …) via a CSS counter; sub-headings keep their dot marker. Any author-written
N.prefix in a heading is stripped from the TOC label so the number isn't shown twice.Verification
pnpm buildclean;pnpm run typecheck+biome checkclean.Summary by CodeRabbit
New Features
Documentation